package ongd.negocio.gestion;

import java.io.Serializable;
import java.util.List;
import javax.persistence.Basic;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.OneToMany;
import javax.persistence.Table;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;

/**
 * Clase que corresponde a la entidad Indice de la base
 * de datos.
 *
 * @author <a href="mailto:egi0002@alu.ubu.es">Elena García Iglesias</a>
 * @author <a href="mailto:cms0021@alu.ubu.es">Cristina Martínez Sanz</a>
 * @version 1.0 20120124
 *
 */
@Entity
@Table(name = "indice")
@XmlRootElement
@NamedQueries({
    @NamedQuery(name = "Indice.findAll", query = "SELECT i FROM Indice i"),
    @NamedQuery(name = "Indice.findByIdIndice", query = "SELECT i FROM Indice i WHERE i.idIndice = :idIndice"),
    @NamedQuery(name = "Indice.findByNombre", query = "SELECT i FROM Indice i WHERE i.nombre = :nombre"),
    @NamedQuery(name = "Indice.findByUrl", query = "SELECT i FROM Indice i WHERE i.url = :url")})
public class Indice extends Entidad implements Serializable {

    /**
     * Identificador de la cuota.
     */
    private static final long serialVersionUID = 1L;
    /**
     * Atributo que corresponde con el identificador del índice.
     */
    @Id
    @Basic(optional = false)
    @Column(name = "idIndice")
    private Integer idIndice;
    /**
     * Atributo que corresponde con el nombre del índice.
     */
    @Basic(optional = false)
    @Column(name = "nombre")
    private String nombre;
    /**
     * Atributo que corresponde con la url del índice.
     */
    @Column(name = "url")
    private String url;
    /**
     * Atributo que corresponde con los hijos del índice.
     */
    @OneToMany(mappedBy = "indiceidIndice")
    private List<Indice> indiceList;
    /**
     * Atributo que corresponde con el padre del índice.
     */
    @JoinColumn(name = "indice_idIndice", referencedColumnName = "idIndice")
    @ManyToOne
    private Indice indiceidIndice;

    /**
     * Constructor de la clase.
     */
    public Indice() {
    }

    /**
     * Constructor de la clase.
     * @param idIndice identificador del índice. 
     */
    public Indice(Integer idIndice) {
        this.idIndice = idIndice;
    }

    /**
     * Constructor de la clase.
     * @param idIndice identificador del índice.
     * @param nombre nombre del índice. 
     */
    public Indice(Integer idIndice, String nombre) {
        this.idIndice = idIndice;
        this.nombre = nombre;
    }

    /**
     * Método que devuelve el identificador del índice.
     * @return idIndice.
     * @see #setIdIndice
     */
    public Integer getIdIndice() {
        return idIndice;
    }

    /**
     * Método que asigna un nuevo identificador al índice.
     * @param idIndice Nuevo valor de la variable
     * @see #getIdIndice
     */
    public void setIdIndice(Integer idIndice) {
        this.idIndice = idIndice;
    }

    /**
     * Metodo que devuelve el nombre del índice.
     * @return nombre.
     * @see #setNombre
     */
    public String getNombre() {
        return nombre;
    }

    /**
     * Método que asigna un nuevo nombre al índice.
     * @param nombre Nuevo valor de la variable
     * @see #getNombre
     */
    public void setNombre(String nombre) {
        this.nombre = nombre;
    }

    /**
     * Método que devuelve la url de un índice.
     * @return url.
     * @see #setUrl
     */
    public String getUrl() {
        return url;
    }

    /**
     * Método que asigna una nueva url a un índice.
     * @param url Nuevo valor de la variable
     * @see #getUrl
     */
    public void setUrl(String url) {
        this.url = url;
    }

    /**
     * Método que devuelve la lista de hijos de un índice.
     * @return indiceList.
     * @see #setIndiceList
     */
    @XmlTransient
    public List<Indice> getIndiceList() {
        return indiceList;
    }

    /**
     * Método que asigna una nueva lista de hijos a un índice.
     * @param indiceList Nuevo valor de la variable
     * @see #getIndiceList
     */
    public void setIndiceList(List<Indice> indiceList) {
        this.indiceList = indiceList;
    }

    /**
     * Método que devuelve el padre de un índice.
     * @return indiceIndice.
     * @see #setIndiceidIndice
     */
    public Indice getIndiceidIndice() {
        return indiceidIndice;
    }

    /**
     * Método que asigna un nuevo padre al índice.
     * @param indiceidIndice Nuevo valor de la variable
     * @see #getIndiceidIndice
     */
    public void setIndiceidIndice(Indice indiceidIndice) {
        this.indiceidIndice = indiceidIndice;
    }

    /**
     * Método que devuelve un número con una propiedad fundamental, si dos 
     * objetos son iguales el valor retornado por sus respectivos hashCode 
     * debe ser igual.
     * @return hash
     */
    @Override
    public int hashCode() {
        int hash = 0;
        hash += (idIndice != null ? idIndice.hashCode() : 0);
        return hash;
    }

    /**
     * Método que compara si dos indices son iguales.
     * @param object Objeto a comparar
     * @return true o false
     */
    @Override
    public boolean equals(Object object) {
        // TODO: Warning - this method won't work in the case the id fields are not set
        if (!(object instanceof Indice)) {
            return false;
        }
        Indice other = (Indice) object;
        if ((this.idIndice == null && other.idIndice != null) || (this.idIndice != null && !this.idIndice.equals(other.idIndice))) {
            return false;
        }
        return true;
    }

    /**
     * Método que devuelve una cadena con el indice.
     * @return string
     */
    @Override
    public String toString() {
        return "ongd.negocio.gestion.Indice[ idIndice=" + idIndice + " ]";
    }
}
